/*
 * Copyright (c) 2017, 2017, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package com.oracle.svm.hosted.code;

import java.util.Set;
import java.util.TreeSet;

import org.graalvm.compiler.options.Option;

import com.oracle.svm.core.annotate.AutomaticFeature;
import com.oracle.svm.core.graal.GraalFeature;
import com.oracle.svm.core.option.HostedOptionKey;

@AutomaticFeature
public class CFunctionFeature implements GraalFeature {

    public static class Options {
        @Option(help = "Print warning message when @CFunction that needs transition is called from runtime compiled code")//
        public static final HostedOptionKey<Boolean> WarnCFunctionsWithTransition = new HostedOptionKey<>(false);
    }

    private Set<String> warnCFunctionsWithTransition;

    // NOTE: substitution processor is added in NativeImageGenerator.

    @Override
    public void beforeCompilation(BeforeCompilationAccess access) {
        if (warnCFunctionsWithTransition != null) {
            System.out.println("WARNING: @CFunction not marked as NO_TRANSITION reachable during runtime compilation. Calls cannot be inlined.");
            for (String s : warnCFunctionsWithTransition) {
                System.out.println("    " + s);
            }
        }
    }

    void warnRuntimeCompilationReachableCFunctionWithTransition(CFunctionCallStubMethod method) {
        if (Options.WarnCFunctionsWithTransition.getValue()) {
            if (warnCFunctionsWithTransition == null) {
                warnCFunctionsWithTransition = new TreeSet<>();
            }
            warnCFunctionsWithTransition.add(method.format("%H.%n(%p)"));
        }
    }
}
